.. _CVidMode Class: ========================== CVidMode Class ========================== .. toctree:: :maxdepth: 1 * :ref:`Overview` * :ref:`Quick Reference` * :ref:`Constructors` * :ref:`Methods` ---- .. _CVidMode_Overview: Overview --------------- .. note:: The **CVidMode** class handles The structure used for this class is :ref:`CVidMode` ---- .. _CVidMode_QuickRef: Quick Reference --------------- +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Quick Ref** | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CVidMode\:\:CVidMode**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:ActivateVideoMode**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | unsigned long **CVidMode\:\:ApplyBrightnessContrast**\(unsigned long rgb) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:ApplyFadeAmount**\(int nColor) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | unsigned long **CVidMode\:\:ApplyFadeAmount**\(unsigned long rgb) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CVidMode\:\:ApplyFadeAmount**\(:ref:`CVIDPALETTE_COLOR`\* pColor) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:BKLock**\(:ref:`CRect`\& rBack) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:BKRender**\(:ref:`CParticle`\* pParticle, :ref:`CRect`\& rClipRect, unsigned short nFlag, unsigned short nBlobSize) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:BKRenderEllipse**\(:ref:`CPoint`\& ptCenter, CSize\& axes, :ref:`CRect`\& rClip, unsigned long rgbColor) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:BKUnlock**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual int __cdecl **CVidMode\:\:ClipLine**\(int\& nXFrom, int\& nYFrom, int\& nXTo, int\& nYTo, :ref:`CRect`\& rClip) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | unsigned long **CVidMode\:\:ConvertToSurfaceRGB**\(unsigned long rgb) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:CreateSurfaces3d**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:DestroySurfaces3d**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void __cdecl **CVidMode\:\:DisableScissoring**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:DrawEllipse**\(:ref:`CPoint`\& ptCenter, CSize\& axis, :ref:`CRect`\& rClip, unsigned long rgbColor) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CVidMode\:\:DrawEllipseArc**\(int degreesBegin, int degreesEnd, :ref:`CPoint`\& ptCenter, float radiusX, float radiusY, unsigned long rgbColor, bool drawWedges, float thickness, int rotationDegrees) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CVidMode\:\:DrawGradientLine**\(float xFrom, float yFrom, float xTo, float yTo, float thickness, unsigned long innerColor, unsigned long outerColor) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CVidMode\:\:DrawGradientLine**\(float xFrom, float xFromIn, float xFromOut, float yFrom, float yFromIn, float yFromOut, float xTo, float xToIn, float xToOut, float yTo, float yToIn, float yToOut, int innerColor, int outerColor, bool thin) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:DrawLine**\(int nXFrom, int nYFrom, int nXTo, int nYTo, :ref:`CRect`\& rSurface, unsigned long rgbColor) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CVidMode\:\:DrawLine2d**\(int nXFrom, int nYFrom, int nXTo, int nYTo, :ref:`CRect`\& rSurface, unsigned long rgbColor, float width, float inPad, float outPad, float segmentLength, float segmentPadding) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CVidMode\:\:DrawOutlineEllipse**\(:ref:`CPoint`\& ptCenter, int radiusX, int radiusY, unsigned long rgbColor) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:DrawRect**\(:ref:`CRect`\& r, :ref:`CRect`\& rClip, unsigned long rgbColor) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CVidMode\:\:DrawRecticle**\(:ref:`CPoint` ptCenter, int radiusX, int radiusY, unsigned long rgbColor) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:DrawRectZoomed**\(:ref:`CRect`\& rT, unsigned long rgbColor) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void __cdecl **CVidMode\:\:EnableScissoring**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:FillPoly3d**\(:ref:`CPoint`\* pPoly, const short nVertices, :ref:`CRect`\& rSurface, unsigned long rgbColor, :ref:`CPoint`\& ptOffset) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void __cdecl **CVidMode\:\:FillRect3d**\(:ref:`CRect`\& rDest, :ref:`CRect`\& rClip, const unsigned long rgbaColor) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CVidMode\:\:Flip**\(int bRenderCursor) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:FXBltToBack**\(:ref:`CRect`\& rFXRect, int x, int y, int nRefPointX, int nRefPointY, :ref:`CRect`\& rClip, unsigned long dwFlags) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:FXLock**\(:ref:`CRect`\& rFXRect, unsigned long dwFlags) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:FXPrep**\(:ref:`CRect`\& rFXRect, unsigned long dwFlags, :ref:`CPoint`\& ptPos, :ref:`CPoint`\& ptReference, :ref:`CRect`\& rClip) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:FXRender**\(:ref:`CVidCell`\* pVidCell, int nRefPointX, int nRefPointY, unsigned long dwFlags, int nTransValue) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:FXRenderAlpha**\(:ref:`CVidCell`\* pVidCell, int nRefPointX, int nRefPointY, unsigned long dwFlags, int nTransValue) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:FXRenderPoly**\(CVidPoly\* pPoly, :ref:`CRect`\& rClip, unsigned long dwColor, unsigned long dwFlags, :ref:`CPoint`\& ptRef, int bMonoY) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:FXUnlock**\(unsigned long dwFlags, :ref:`CRect`\* pFxRect, :ref:`CPoint`\& ptRef) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | long **CVidMode\:\:GetEllipseArcPixelList**\(long nMajorAxis, long nMinorAxis, unsigned char\* pPixelList) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:GetFXSize**\(CSize\& size) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | unsigned long **CVidMode\:\:GetGlobalTintColor**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`CVidCell`\* **CVidMode\:\:GetPointer**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`CRect` **CVidMode\:\:GetSafeZone**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | float **CVidMode\:\:GetScaleAmount**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`CPoint` **CVidMode\:\:mouseToScreen**\(int x, int y) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:OutlinePoly**\(:ref:`CPoint`\* pPoly, const short nVertices, :ref:`CRect`\& rSurface, unsigned long rgbColor, :ref:`CPoint`\& ptOffset) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:OutlinePoly3d**\(:ref:`CPoint`\* pPoly, const short nVertices, :ref:`CRect`\& rSurface, unsigned long rgbColor, :ref:`CPoint`\& ptOffset) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:PolyLine**\(:ref:`CRect`\& rSurface, tagPOINT\* lpPoints, int nCount, unsigned long rgbColor, int nThickness) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | unsigned char **CVidMode\:\:PrintSurfaceToBmp**\(unsigned char\*\& pRGBBytes, :ref:`CRect`\& rClip, long\& nDataSize, short nRatio) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | unsigned char **CVidMode\:\:PrintSurfaceToBmp3d**\(unsigned char\*\& pRGBBytes, :ref:`CRect`\& rClip, long\& nDataSize, short nRatio) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | virtual void __cdecl **CVidMode\:\:RenderBlackFade3d**\(:ref:`CRect` viewport) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:RenderBlack**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:RenderHWPointerImage**\(:ref:`CVidCell`\* pCursor, int nNumber, int x, int y, :ref:`CRect` rClip) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:RenderPointer**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:RenderSWPointerImage**\(:ref:`CVidCell`\* pTempPointerVidCell, int nNumber, int x, int y, :ref:`CRect` rClip) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CVidMode\:\:ResetViewport**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | unsigned char **CVidMode\:\:SaveScreen**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`CPoint` **CVidMode\:\:screenToUi**\(int x, int y, int menuWidth, int menuHeight) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CVidMode\:\:ScrollViewportX**\(int x) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CVidMode\:\:ScrollViewportY**\(int y) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void **CVidMode\:\:Set3dClipRect**\(:ref:`CRect`\& rClip) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:SetDisplayMode**\() | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:SetPointer**\(:ref:`CVidCell`\* pVidCell, unsigned char bAnimating, int nPointerNumber) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | int **CVidMode\:\:SetPointer**\(:ref:`CVidCell`\* pVidCell, :ref:`CResRef` resRef, unsigned char bAnimating, int nPointerNumber) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`CPoint` **CVidMode\:\:uiToScreen**\(int x, int y) | +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ---- .. _CVidMode_Constructors: Constructors --------------- +-------------------------------------------------+------------------------------------------------------+ | **Name** | **Description** | +-------------------------------------------------+------------------------------------------------------+ | :ref:`CVidMode\:\:CVidMode` | Constructs a ``CVidMode`` object | +-------------------------------------------------+------------------------------------------------------+ .. _CVidModeCVidMode: CVidMode\:\:CVidMode ^^^^^^^^^^^^^^^^^^^^^^^^^ Constructs a ``CVidMode`` object :: void CVidMode::CVidMode(); **Remarks** Constructs a ``CVidMode`` object ---- .. _CVidMode_Methods: Methods --------------- +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | **Name** | **Description** | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:ActivateVideoMode` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:ApplyBrightnessContrast` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:ApplyFadeAmount` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:BKLock` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:BKRender` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:BKRenderEllipse` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:BKUnlock` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:ClipLine` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:ConvertToSurfaceRGB` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:CreateSurfaces3d` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:DestroySurfaces3d` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:DisableScissoring` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:DrawEllipse` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:DrawEllipseArc` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:DrawGradientLine` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:DrawLine` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:DrawLine2d` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:DrawOldRecticle` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:DrawOutlineEllipse` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:DrawRect` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:DrawRecticle` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:DrawRectZoomed` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:EnableScissoring` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:FillPoly3d` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:FillRect3d` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:Flip` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:FXBltToBack` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:FXLock` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:FXPrep` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:FXRender` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:FXRenderAlpha` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:FXRenderPoly` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:FXUnlock` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:GetEllipseArcPixelList` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:GetFXSize` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:GetGlobalTintColor` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:GetPointer` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:GetSafeZone` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:GetScaleAmount` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:mouseToScreen` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:OutlinePoly` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:OutlinePoly3d` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:PolyLine` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:PrintSurfaceToBmp` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:PrintSurfaceToBmp3d` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:RenderBlackFade3d` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:RenderBlack` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:RenderHWPointerImage` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:RenderPointer` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:RenderSWPointerImage` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:ResetViewport` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:SaveScreen` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:screenToUi` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:ScrollViewportX` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:ScrollViewportY` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:Set3dClipRect` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:SetDisplayMode` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:SetPointer` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CVidMode\:\:uiToScreen` | | +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ ---- .. _CVidModeActivateVideoMode: CVidMode\:\:ActivateVideoMode ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::ActivateVideoMode(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeApplyBrightnessContrast: CVidMode\:\:ApplyBrightnessContrast ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::ApplyBrightnessContrast(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeApplyFadeAmount: CVidMode\:\:ApplyFadeAmount ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::ApplyFadeAmount(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- CVidMode\:\:ApplyFadeAmount ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::ApplyFadeAmount(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- CVidMode\:\:ApplyFadeAmount ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::ApplyFadeAmount(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeBKLock: CVidMode\:\:BKLock ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::BKLock(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeBKRender: CVidMode\:\:BKRender ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::BKRender(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeBKRenderEllipse: CVidMode\:\:BKRenderEllipse ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::BKRenderEllipse(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeBKUnlock: CVidMode\:\:BKUnlock ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::BKUnlock(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeClipLine: CVidMode\:\:ClipLine ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::ClipLine(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeConvertToSurfaceRGB: CVidMode\:\:ConvertToSurfaceRGB ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::ConvertToSurfaceRGB(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeCreateSurfaces3d: CVidMode\:\:CreateSurfaces3d ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::CreateSurfaces3d(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeDestroySurfaces3d: CVidMode\:\:DestroySurfaces3d ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::DestroySurfaces3d(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeDisableScissoring: CVidMode\:\:DisableScissoring ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::DisableScissoring(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeDrawEllipse: CVidMode\:\:DrawEllipse ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::DrawEllipse(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeDrawEllipseArc: CVidMode\:\:DrawEllipseArc ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::DrawEllipseArc(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeDrawGradientLine: CVidMode\:\:DrawGradientLine ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::DrawGradientLine(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- CVidMode\:\:DrawGradientLine ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::DrawGradientLine(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeDrawLine: CVidMode\:\:DrawLine ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::DrawLine(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeDrawLine2d: CVidMode\:\:DrawLine2d ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::DrawLine2d(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeDrawOldRecticle: CVidMode\:\:DrawOldRecticle ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::DrawOldRecticle(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeDrawOutlineEllipse: CVidMode\:\:DrawOutlineEllipse ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::DrawOutlineEllipse(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeDrawRect: CVidMode\:\:DrawRect ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::DrawRect(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeDrawRecticle: CVidMode\:\:DrawRecticle ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::DrawRecticle(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeDrawRectZoomed: CVidMode\:\:DrawRectZoomed ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::DrawRectZoomed(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeEnableScissoring: CVidMode\:\:EnableScissoring ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::EnableScissoring(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeFillPoly3d: CVidMode\:\:FillPoly3d ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::FillPoly3d(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeFillRect3d: CVidMode\:\:FillRect3d ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::FillRect3d(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeFlip: CVidMode\:\:Flip ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::Flip(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeFXBltToBack: CVidMode\:\:FXBltToBack ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::FXBltToBack(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeFXLock: CVidMode\:\:FXLock ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::FXLock(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeFXPrep: CVidMode\:\:FXPrep ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::FXPrep(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeFXRender: CVidMode\:\:FXRender ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::FXRender(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeFXRenderAlpha: CVidMode\:\:FXRenderAlpha ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::FXRenderAlpha(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeFXRenderPoly: CVidMode\:\:FXRenderPoly ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::FXRenderPoly(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeFXUnlock: CVidMode\:\:FXUnlock ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::FXUnlock(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeGetEllipseArcPixelList: CVidMode\:\:GetEllipseArcPixelList ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::GetEllipseArcPixelList(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeGetFXSize: CVidMode\:\:GetFXSize ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::GetFXSize(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeGetGlobalTintColor: CVidMode\:\:GetGlobalTintColor ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::GetGlobalTintColor(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeGetPointer: CVidMode\:\:GetPointer ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::GetPointer(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeGetSafeZone: CVidMode\:\:GetSafeZone ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::GetSafeZone(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeGetScaleAmount: CVidMode\:\:GetScaleAmount ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::GetScaleAmount(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModemouseToScreen: CVidMode\:\:mouseToScreen ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::mouseToScreen(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeOutlinePoly: CVidMode\:\:OutlinePoly ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::OutlinePoly(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeOutlinePoly3d: CVidMode\:\:OutlinePoly3d ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::OutlinePoly3d(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModePolyLine: CVidMode\:\:PolyLine ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::PolyLine(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModePrintSurfaceToBmp: CVidMode\:\:PrintSurfaceToBmp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::PrintSurfaceToBmp(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModePrintSurfaceToBmp3d: CVidMode\:\:PrintSurfaceToBmp3d ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::PrintSurfaceToBmp3d(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeRenderBlackFade3d: CVidMode\:\:RenderBlackFade3d ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::RenderBlackFade3d(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeRenderBlack: CVidMode\:\:RenderBlack ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::RenderBlack(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeRenderHWPointerImage: CVidMode\:\:RenderHWPointerImage ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::RenderHWPointerImage(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeRenderPointer: CVidMode\:\:RenderPointer ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::RenderPointer(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeRenderSWPointerImage: CVidMode\:\:RenderSWPointerImage ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::RenderSWPointerImage(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeResetViewport: CVidMode\:\:ResetViewport ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::ResetViewport(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeSaveScreen: CVidMode\:\:SaveScreen ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::SaveScreen(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModescreenToUi: CVidMode\:\:screenToUi ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::screenToUi(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeScrollViewportX: CVidMode\:\:ScrollViewportX ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::ScrollViewportX(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeScrollViewportY: CVidMode\:\:ScrollViewportY ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::ScrollViewportY(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeSet3dClipRect: CVidMode\:\:Set3dClipRect ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::Set3dClipRect(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeSetDisplayMode: CVidMode\:\:SetDisplayMode ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::SetDisplayMode(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeSetPointer: CVidMode\:\:SetPointer ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::SetPointer(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- CVidMode\:\:SetPointer ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::SetPointer(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks** ---- .. _CVidModeuiToScreen: CVidMode\:\:uiToScreen ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: CVidMode::uiToScreen(); **Parameters** * * - * * - * * - * * - **Return Value** Returns **Remarks**